Add docs for react-router CLI #14148
Open
+124
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
brookslybrand
approved these changes
Aug 11, 2025
brophdawg11
approved these changes
Aug 11, 2025
|
|
||
| ## `react-router typegen` | ||
|
|
||
| Generates TypeScript types for your routes. This happens automatically during development, but you can manually run it when needed, e.g. to generate types in CI before running `tsc`. |
There was a problem hiding this comment.
Might be worth a cross-link to https://reactrouter.com/explanation/type-safety somewhere in here?
Suggested change
| Generates TypeScript types for your routes. This happens automatically during development, but you can manually run it when needed, e.g. to generate types in CI before running `tsc`. | |
| Generates TypeScript types for your routes. This happens automatically during development, but you can manually run it when needed, e.g. to generate types in CI before running `tsc`. See [Type Safety][type-safety] for more information. |
|
|
||
| React Router handles the entry points of your application by default. | ||
|
|
||
| If you want to have control over these entry points, you can run `npx react-router reveal` to generate the `entry.client.tsx` and `entry.server.tsx` files in your `app` directory. When these files are present, React Router will use them instead of the defaults. |
There was a problem hiding this comment.
Suggested change
| If you want to have control over these entry points, you can run `npx react-router reveal` to generate the `entry.client.tsx` and `entry.server.tsx` files in your `app` directory. When these files are present, React Router will use them instead of the defaults. | |
| If you want to have control over these entry points, you can run `npx react-router reveal` to generate the [`entry.client.tsx`][entry-client] and [`entry.server.tsx`][entry-server] files in your `app` directory. When these files are present, React Router will use them instead of the defaults. |
| | `--watch` | Watch for changes | `boolean` | `false` | | ||
|
|
||
| [loaders]: ../../start/framework/data-loading | ||
| [vite]: https://vite.dev |
There was a problem hiding this comment.
Suggested change
| [vite]: https://vite.dev | |
| [vite]: https://vite.dev | |
| [entry-server]: ../framework-conventions/entry.server.tsx | |
| [entry-client]: ../framework-conventions/entry.client.tsx | |
| [type-safety]: ../../explanation/type-safety |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a follow-up to #14144, this is a port of the Remix CLI docs, with all references to Remix updated, and all irrelevant details removed.
I've also added docs for the
reveal,routesandtypegencommands as these were missing in the original docs.